home *** CD-ROM | disk | FTP | other *** search
/ Dictionaries & Language / Dictionaries and Language (Chestnut CD-ROM) (1993).iso / utils / mycd / mycd.doc < prev   
Encoding:
Text File  |  1989-02-15  |  6.7 KB  |  129 lines
  1. _____USAGE
  2.  
  3. MYCD  [[$env_var] [d:][path/]directory]
  4.  
  5. _____DESCRIPTION
  6.  
  7. MYCD is an alternative to the MS-DOS(tm) cd command that offers shortcut ways
  8. to change the current directory [or drive].  MYCD interprets wildcards, 
  9. forward and reverse slashes, dots, environmental variables, and will use a 
  10. variable CDPATH, if defined, to direct its search pattern for a directory.
  11.  
  12. An environmental variable is given by preceding it by a '$' or a '%'.  For
  13. example, if there is an environmental variable SRC,  "MYCD $src"  (or 
  14. "MYCD %src" ) will change to the directory defined by SRC.  An environmental
  15. variable can precede a path ( "MYCD $src/pa*" ), but any '$' or '%' will be 
  16. interpreted literally when interior to the path.
  17.  
  18. MYCD will deal with a drive request ( "MYCD d:..." ) by actually changing to
  19. the drive specified.  This is different than MS-DOS's cd behavior, where
  20. under the same circumstances, the current directory on the drive is changed,
  21. but the present working directory remains the same (no drive change).
  22.  
  23. After dealing with the drive information, MYCD has the same notion of 
  24. `absolute' or `relative' changes of directory as does the MS-DOS cd.
  25.  
  26. If the path requested, after being stripped of any drive information, begins
  27. with a slash, then the path change is interpreted relative to the root
  28. directory.  Thus, the following absolute changes are determined:
  29.   MYCD \path          change to \path on current drive
  30.   MYCD d:\path        change to \path on drive d:
  31.  
  32. The alternative is that the path is considered as a relative path.  If an
  33. environmental variable CDPATH is _not_ set, changes are made relative to the
  34. current directory.  For example, "MYCD dog" will change to the subdirectory
  35. dog of the current directory, if there is one.  General examples (with "path"
  36. having no leading slash):
  37.   MYCD path           change to path relative to current dir, on current drive
  38.   MYCD d:             change to current dir on drive d:
  39.   MYCD d:path         change to path relative to current dir on drive d:
  40.   MYCD [no args]      change to root dir (\) on current drive (an exception)
  41.  
  42. If an environmental variable CDPATH is specified (e.g., with the MS-DOS SET
  43. command), MYCD's changes relative to a current directory are modified.  That
  44. is, MYCD will deal with `absolute' paths having a slash at the beginning, or
  45. paths beginning with an environmental variable, just as described above,
  46. but will deal with other paths relative to the contents of CDPATH.  
  47.  
  48. CDPATH is a list of paths, delimited by ';', similar to PATH.  For example, 
  49.     "set CDPATH=.;\;c:\;e:\upload;..;h:\work".   
  50. MYCD will successively treat each of the paths specified as the current
  51. directory, and try to change relative to that directory.  For example, with
  52. the above CDPATH,   "MYCD rep*/d*"   will change to h:\work\reports\daily
  53. if h:\work is the first entry with a subdirectory name matching the pattern
  54. "rep*/d*".  A judicious setting of CDPATH is very valuable; note that it is 
  55. the PARENTS of frequently accessed paths that should be specified in CDPATH.
  56. For example, the choice "e:\upload" above, should mean that you wish to 
  57. access various subdirectories of e:\upload by name, not that e:\upload is
  58. frequently accessed.  It would be strange to have anything other than '.' 
  59. as the first entry in CDPATH, so be sure to do this!  
  60.  
  61. MYCD allows wildcards '*' and '?' throughout the path.  These are interpreted
  62. in the MS-DOS style and a change will be made to the first matching directory
  63. found by MS-DOS (no attempt is made to resolve ambiguity).  For example, if
  64. you have subdirs bat, batch, backup, bad.dir and you issue "MYCD ba*d*" you
  65. can land in any of these except bad.dir.  (This is what MS-DOS function calls
  66. do (sigh).  If you are confused, look up wildcards in your MS-DOS manual.)
  67.  
  68. MYCD deals equally well with forward and reverse slashes.  It will reduce
  69. multiple consecutive slashes to just one slash.  It also understands "." as
  70. the current directory and ".." as a parent, when delimited anywhere in a
  71. given path.  Thus "MYCD cow\dog//./\\..\/cat\"  is equivalent to  
  72. "MYCD cow\cat".  As a  bonus, 3 dots mean grandparent directory (e.g., 
  73. "MYCD c:\x\y\z\..."  <->  "MYCD  c:\x"  or  MYCD e:...  <->  MYCD e:../..  ),
  74. and 4 dots for great-grandparent,...
  75.  
  76. MYCD sets the MS-DOS errorlevel to 1 if it fails to change directory.  MYCD
  77. does not print anything unless an error occurs.
  78.  
  79. _____HINTS
  80.  
  81. Copy MYCD.com to a ramdisk (d:\ say) at boot time and use an aliasing to make
  82. cd a synonym for d:\mycd.  (Since the surrogate cd command will not be part
  83. of command.com, you want it to load and execute as quickly as possible.)
  84.  
  85. It is not a good idea to put into CDPATH any path that begins with a floppy
  86. drive that is sometimes empty:  you have instructed MYCD to look there.  If
  87. you get the "Not ready error reading drive X" message while executing MYCD,
  88. processing will be aborted unless you put a valid disk in the drive and
  89. retry.
  90.  
  91. A request "MYCD $dirname" with the intent of changing to a directory whose
  92. name begins with '$' will fail.  If you actually give directories names
  93. beginning with '$' or '%', hide this from MYCD.  For example, use
  94. "MYCD ./$dirname".
  95.  
  96. _____BUGS and LIMITATIONS
  97.  
  98. Resolution of wildcards can cause some surprises.  If subdir aaa has subdirs
  99. bb1 and bb2; and bb2 has subdir cc3, the request "MYCD a*/b*/c*" may or may
  100. not work, depending on the directory ordering maintained by MS-DOS.  The path
  101. may expand as aaa/b*/c* to aaa/bb1/c*, for which there is no match; or it may
  102. expand as aaa/b*/c* to aaa/bb2/c* to aaa/bb2/cc3.  I don't think that the
  103. extra complexity needed to deal with the generality of situations like this
  104. is warranted.
  105.  
  106. Environmental variables are treated as upper case, which is normal for
  107. MS-DOS.  For example, "set src=f:\srcdir" actually stores an environmental
  108. variable named SRC.  If you use some utility and put mixed case in
  109. environmental variables, MYCD will not find these.
  110.  
  111. When an environmental variable is specified as the initial part of an
  112. argument, MYCD does not use CDPATH.  For example, "set up=.." and "MYCD $up"
  113. will operate, but "set b=b*" and "cd $b" will look for a directory "./b*",
  114. which isn't very useful.  The lesson here is to use environmental variables
  115. that specify a relative motion or include drive and complete path.
  116.  
  117. The number of characters in the full name of the path of the new directory
  118. cannot exceed 127 characters.  CDPATH cannot contain more than 191
  119. characters.  Results are unpredictable if these limits are exceeded.
  120.  
  121. MYCD says its name as "cd" in error messages, regardless of what you call it.
  122.  
  123. _____AUTHOR
  124.  
  125. J. Martin Borden
  126. att!granjon!marty   or   marty%garage.att.com
  127.  
  128. There is no warrantee, expressed or implied, with this distribution.
  129.